<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkAccelLabel</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 3 参考手册">
<link rel="up" href="DisplayWidgets.html" title="显示构件">
<link rel="prev" href="DisplayWidgets.html" title="显示构件">
<link rel="next" href="gtk3-GtkImage.html" title="GtkImage">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="DisplayWidgets.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="DisplayWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 3 参考手册</th>
<td><a accesskey="n" href="gtk3-GtkImage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gtk3-GtkAccelLabel.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gtk3-GtkAccelLabel.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gtk3-GtkAccelLabel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk3-GtkAccelLabel.top_of_page"></a>GtkAccelLabel</span></h2>
<p>GtkAccelLabel — A label which displays an accelerator key on the right of the text</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gtk3-GtkAccelLabel.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtk/gtk.h&gt;

struct              <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel">GtkAccelLabel</a>;
<a class="link" href="gtk3-GtkWidget.html#GtkWidget" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-new" title="gtk_accel_label_new ()">gtk_accel_label_new</a>                 (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-set-accel-closure" title="gtk_accel_label_set_accel_closure ()">gtk_accel_label_set_accel_closure</a>   (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>,
                                                         <em class="parameter"><code><a href="../gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *accel_closure</code></em>);
<a class="link" href="gtk3-GtkWidget.html#GtkWidget" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-get-accel-widget" title="gtk_accel_label_get_accel_widget ()">gtk_accel_label_get_accel_widget</a>    (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()">gtk_accel_label_set_accel_widget</a>    (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gtk3-GtkWidget.html#GtkWidget" title="GtkWidget"><span class="type">GtkWidget</span></a> *accel_widget</code></em>);
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-get-accel-width" title="gtk_accel_label_get_accel_width ()">gtk_accel_label_get_accel_width</a>     (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-refetch" title="gtk_accel_label_refetch ()">gtk_accel_label_refetch</a>             (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gtk3-GtkAccelLabel.description"></a><h2>Description</h2>
<p>
The <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> widget is a subclass of <a class="link" href="gtk3-GtkLabel.html#GtkLabel" title="struct GtkLabel"><span class="type">GtkLabel</span></a> that also displays an
accelerator key on the right of the label text, e.g. 'Ctl+S'.
It is commonly used in menus to show the keyboard short-cuts for commands.
</p>
<p>
The accelerator key to display is not set explicitly.
Instead, the <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> displays the accelerators which have been added to
a particular widget. This widget is set by calling
<a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()"><code class="function">gtk_accel_label_set_accel_widget()</code></a>.
</p>
<p>
For example, a <a class="link" href="gtk3-GtkMenuItem.html#GtkMenuItem" title="struct GtkMenuItem"><span class="type">GtkMenuItem</span></a> widget may have an accelerator added to emit the
"activate" signal when the 'Ctl+S' key combination is pressed.
A <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> is created and added to the <a class="link" href="gtk3-GtkMenuItem.html#GtkMenuItem" title="struct GtkMenuItem"><span class="type">GtkMenuItem</span></a>, and
<a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()"><code class="function">gtk_accel_label_set_accel_widget()</code></a> is called with the <a class="link" href="gtk3-GtkMenuItem.html#GtkMenuItem" title="struct GtkMenuItem"><span class="type">GtkMenuItem</span></a> as the
second argument. The <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> will now display 'Ctl+S' after its label.
</p>
<p>
Note that creating a <a class="link" href="gtk3-GtkMenuItem.html#GtkMenuItem" title="struct GtkMenuItem"><span class="type">GtkMenuItem</span></a> with <a class="link" href="gtk3-GtkMenuItem.html#gtk-menu-item-new-with-label" title="gtk_menu_item_new_with_label ()"><code class="function">gtk_menu_item_new_with_label()</code></a> (or
one of the similar functions for <a class="link" href="gtk3-gtkcheckmenuitem.html#GtkCheckMenuItem" title="struct GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> and <a class="link" href="gtk3-GtkRadioMenuItem.html#GtkRadioMenuItem" title="struct GtkRadioMenuItem"><span class="type">GtkRadioMenuItem</span></a>)
automatically adds a <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> to the <a class="link" href="gtk3-GtkMenuItem.html#GtkMenuItem" title="struct GtkMenuItem"><span class="type">GtkMenuItem</span></a> and calls
<a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()"><code class="function">gtk_accel_label_set_accel_widget()</code></a> to set it up for you.
</p>
<p>
A <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> will only display accelerators which have <code class="literal">GTK_ACCEL_VISIBLE</code>
set (see <a class="link" href="gtk3-Standard-Enumerations.html#GtkAccelFlags" title="enum GtkAccelFlags"><span class="type">GtkAccelFlags</span></a>).
A <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> can display multiple accelerators and even signal names,
though it is almost always used to display just one accelerator key.
</p>
<div class="example">
<a name="id3287490"></a><p class="title"><b>Example 48. Creating a simple menu item with an accelerator key.</b></p>
<div class="example-contents"><pre class="programlisting">
  GtkWidget *save_item;
  GtkAccelGroup *accel_group;

  /* Create a GtkAccelGroup and add it to the window. */
  accel_group = gtk_accel_group_new ();
  gtk_window_add_accel_group (GTK_WINDOW (window), accel_group);

  /* Create the menu item using the convenience function. */
  save_item = gtk_menu_item_new_with_label ("Save");
  gtk_widget_show (save_item);
  gtk_container_add (GTK_CONTAINER (menu), save_item);

  /* Now add the accelerator to the GtkMenuItem. Note that since we called
     gtk_menu_item_new_with_label() to create the GtkMenuItem the
     GtkAccelLabel is automatically set up to display the GtkMenuItem
     accelerators. We just need to make sure we use GTK_ACCEL_VISIBLE here. */
  gtk_widget_add_accelerator (save_item, "activate", accel_group,
                              GDK_s, GDK_CONTROL_MASK, GTK_ACCEL_VISIBLE);
</pre></div>
</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="gtk3-GtkAccelLabel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkAccelLabel"></a><h3>struct GtkAccelLabel</h3>
<pre class="programlisting">struct GtkAccelLabel {
  GtkLabel label;
  GtkAccelLabelPrivate *priv;
};
</pre>
<p>
The <span class="type">GtkAccelLabel</span> struct contains private data only, and
should be accessed using the functions below.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-new"></a><h3>gtk_accel_label_new ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkWidget.html#GtkWidget" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_accel_label_new                 (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre>
<p>
Creates a new <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>the label string. Must be non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-set-accel-closure"></a><h3>gtk_accel_label_set_accel_closure ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_accel_label_set_accel_closure   (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>,
                                                         <em class="parameter"><code><a href="../gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *accel_closure</code></em>);</pre>
<p>
Sets the closure to be monitored by this accelerator label. The closure
must be connected to an accelerator group; see <a class="link" href="gtk3-Keyboard-Accelerators.html#gtk-accel-group-connect" title="gtk_accel_group_connect ()"><code class="function">gtk_accel_group_connect()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>accel_label</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>accel_closure</code></em> :</span></p></td>
<td>the closure to monitor for accelerator changes.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-get-accel-widget"></a><h3>gtk_accel_label_get_accel_widget ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkWidget.html#GtkWidget" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_accel_label_get_accel_widget    (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);</pre>
<p>
Fetches the widget monitored by this accelerator label. See
<a class="link" href="gtk3-GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()"><code class="function">gtk_accel_label_set_accel_widget()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>accel_label</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the object monitored by the accelerator label, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-set-accel-widget"></a><h3>gtk_accel_label_set_accel_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_accel_label_set_accel_widget    (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gtk3-GtkWidget.html#GtkWidget" title="GtkWidget"><span class="type">GtkWidget</span></a> *accel_widget</code></em>);</pre>
<p>
Sets the widget to be monitored by this accelerator label.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>accel_label</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>accel_widget</code></em> :</span></p></td>
<td>the widget to be monitored.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-get-accel-width"></a><h3>gtk_accel_label_get_accel_width ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_accel_label_get_accel_width     (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);</pre>
<p>
Returns the width needed to display the accelerator key(s).
This is used by menus to align all of the <a class="link" href="gtk3-GtkMenuItem.html#GtkMenuItem" title="struct GtkMenuItem"><span class="type">GtkMenuItem</span></a> widgets, and shouldn't
be needed by applications.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>accel_label</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the width needed to display the accelerator key(s).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-refetch"></a><h3>gtk_accel_label_refetch ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_accel_label_refetch             (<em class="parameter"><code><a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);</pre>
<p>
Recreates the string representing the accelerator keys.
This should not be needed since the string is automatically updated whenever
accelerators are added or removed from the associated widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>accel_label</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkAccelLabel.html#GtkAccelLabel" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>always returns <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gtk3-GtkAccelLabel.see-also"></a><h2>See Also</h2>
<a class="link" href="gtk3-Keyboard-Accelerators.html#GtkAccelGroup" title="struct GtkAccelGroup"><span class="type">GtkAccelGroup</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>